Devices > Remote Devices > Emerson ROC EIE > Data Groups

Data Groups

With few exceptions, data groups must be defined in a device template file in order for them to be available for use on a remote device. Which data groups are defined by a device template file depends on protocol, device type, and unique configuration.

CygNet distributes sample device template files for its EIEs, each of which typically serves one or more hardware models along with applicable firmware. Therefore, the data groups described below are only those data groups defined by CygNet in sample device template file(s). Your template(s) might not include some of the data groups described below. Device template files exist to enable users to customize device configurations; however, CygNet is not responsible for changes made by users.

For information about data group definitions and device template files, see Device Template Files.

For more information about data group dependencies, see Data Group Dependencies.

Note: Except for UDC mapping, native, predefined data groups can not be altered in the device template file. Only the "Generic TLP Data" data group enables user alterations.

Note: A valid "ROC Config" (RtuConfig) data group must be retrieved before other data groups can be retrieved or sent. The data group should always be repolled if there are configuration changes to the field device, after a CygNet upgrade, after importing a device or after modifying the device template file.

Note: The attribute minFirmwareVer can be configured in the device template file to specify the minimum firmware version supported for the specified TLP of the DEID. If the firmware version information has not been successfully retrieved from the field device, any TLP using the minFirmwareVer attribute will be excluded. To retrieve the firmware version information, poll the "ROC Config" (RtuConfig) data group or the "System Variables" (SysVars) data group.

Note: CygNet Gas Measurement Repository (GMR) has been discontinued. Effective with the CygNet v8.5.0 release, GMR files must be migrated to FMS. See Migrating Data Groups from GMR to FMS to migrate data groups for Emerson ROC devices.

Browse by letter:     A     B     C     D     E     F     G     H     I     L     M     P     R     S     T     U     V     X

Data Group Type Usage Notes

AGAFlowVal

The "AGA Flow Calc Values" data group uses point type 10.

AGAParams

The "AGA Gas/Flow Parms" data group uses point type 7.

AI

The "Analog Input" data group uses point type 3.

AlarmsLog

"Alarms Log"

AO

The "Analog Output" data group uses point type 4.

ArchDay

"Daily Archive Data"

AuditClear

"Audit Log Clearing" only applies to Industry Canada (IC) devices.

The "Audit Log Clearing" data group enables viewing of "Audit Log" transactions for every manual clear executed using the "Audit Log" data group.

Use the Transaction drop-down menu to view failed and successful gets. Each get represents an attempt to clear event records in the "Audit Log" data group.

AuditLog

"Audit Log" only applies to Industry Canada (IC) devices.

The "Audit Log" data group enables the auditing of a select group of events.

Note: In the following entry, the word clear has two, potentially confusing meanings. Records marked cleared/uncleared are records that have been recorded as read and saved by the host. However, clearing an audit log means deleting all event records from the audit log.

The following notes apply to only 300/IC and 400/IC devices:

In the Date Parameters dialog box that appears when you click Get from RTU, the following options appear:

  • Start Date and End Date enable you to request all event records for a given time span of up to 240 event records. Event records retrieved include both cleared and uncleared records.
  • If you check Get all uncleared records, only all uncleared event records are retrieved. Previously cleared records are not retrieved.
  • If you want uncleared event records to be marked cleared and all event records deleted from the audit log after a get, click Clear all records after get.

Under Options, click Clear Log to delete all event records from the audit log.

The following notes apply to only 107/IC devices:

Event records retrieved from 107/IC field devices are always returned marked as cleared, so Get all uncleared records is unavailable with 107/IC devices.

Under Options, click Clear Log to delete all event records from the audit log.

BasicPoll

"Basic Poll"

CmdWrCfgM

"CMD – Write Config Memory" is a special case of "Generic TLP Data" for writing to config memory.

ConOpCfg

"Configurable Opcode Settings"

If you add this data group, also add a "Configurable Opcode Data" data group.

Use ROCLINK to configure a configurable opcode table. Although ROCLINK allows you to skip items when configuring the table, CygNet does not require that the items be contiguous.

If you make changes to the opcode table configuration, poll this data group afterward.

ConOpCode

The "Configurable Opcode Data" data group works in conjunction with a "Configurable Opcode Settings" data group. Retrieving this data group automatically retrieves required configurable opcode settings.

If you add this data group, also add a "Configurable Opcode Settings" data group.

Use ROCLINK to configure a configurable opcode table. Although ROCLINK allows you to skip items when configuring the table, CygNet does not require that the items be contiguous.

If you make changes to the opcode table configuration, poll this data group afterwards.

If you request a "Configurable Opcode Data" data group for an Emerson ROC remote device, you receive an invalid header error if the table contains one or more user-defined points (UDPs) for which the data type is not a floating point number (FLP). The EIE does not know the data type for user-defined points because they are user-defined.

DateTime

"Time / Date"

DensityIF

The "Density Interface Parameters" data group uses point type 26.

See also Collecting Liquid Periodic Data.

DI

The "Discrete Input" data group uses point type 1.

Diag

"Diagnostics Summary"

Diag00

"Diagnostics: CPU Module"

Diag01Dvs

"Diagnostics: Integral Sensor DVS"

Diag01Pim

"Diagnostics: Integral Sensor PIM"

Diag02

"Diagnostics: LCD Controller"

Diag03

"Diagnostics: LCD Module"

Diag04Io

"Diagnostics: Slot 0 Onboard I/O"

Diag04NoIo

"Diagnostics: Slot 0 No I/O"

Diag05Aux

"Diagnostics: Slot 1 Aux I/O"

Diag05Mvs

"Diagnostics: Slot 1 MVS I/F"

Diag06Aux

"Diagnostics: Slot 2 Aux I/O"

Diag06Mvs

"Diagnostics: Slot 2 MVS I/F'

Diag07Aux

"Diagnostics: Slot 3 Aux I/O"

Diag07Mvs

"Diagnostics: Slot 3 MVS I/F"

Diag08Aux

"Diagnostics: Slot 4 Aux I/O"

Diag08Mvs

"Diagnostics: Slot 4 MVS I/F"

Diag09Aux

"Diagnostics: Slot 5 Aux I/O"

Diag09Mvs

"Diagnostics: Slot 5 MVS I/F"

Diag10Aux

"Diagnostics: Slot 6 Aux I/O"

Diag10Mvs

"Diagnostics: Slot 6 MVS I/F"

Diag11Aux

"Diagnostics: Slot 7 Aux I/O"

Diag11Mvs

"Diagnostics: Slot 7 MVS I/F"

DO

The "Discrete Output" data group uses point type 2.

EventsLog

"Events Log "

ExtHst

"Extended History"

See History Retrieval Optimization.

ExtHstParm

"Extended History Parameters"

Note: Only one instance of this data group is allowed.

FmsAlarm

"FMS Alarms"

FMS data group units displayed in the DDS reflect their points of origin.

Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time.

Dependencies:
  • "Alarms Log"
  • "FMS Configuration Data"

FmsConfig

"FMS Configuration" is required if you use FMS.

When adding an "FMS Configuration" data group, specify the meter type and ordinal number of the supporting meter configuration data group in the Meter Type area.

The Ordinal values supplied reflect FloBoss 107 meter support, which provides a maximum of 4 gas meters + a maximum of 2 liquid meters. The 2 liquid meters become available only after loading the Liquid Allocation user program to the applicable FloBoss 107 field device. When you select a gas meter type, you can choose from 4 ordinals or meters. When you select a liquid meter type, you can choose from 2 ordinals or meters.

Possible meter type options are as follows:

  • Orifice
  • Turbine
  • Cone
  • Liquid Coriolis
  • Liquid Orifice
  • Liquid Positive Displacement
  • Liquid Turbine
  • Liquid Ultrasonic

This data group supports send/write functionality. However, sends can only be initiated from FMS. Sending periodic quality from FMS to a field device requires you to instantiate each "FMS Configuration" support data group for the applicable remote device before initiating the send from FMS.

For information about how this data group maps to FMS config items in a 107 device, see FMS Config Data Group Mapping.

FMS data group units displayed in the DDS reflect their points of origin.

"FMS Configuration" must be retrieved before polling other FMS data groups of the same ordinal.

Dependencies:
  • "AGA Gas/Flow Parms" (AGAParams) (For 100, 107, and 500 field devices prior to v8.1.1; for 407 field devices, point type 7, parameter 43 (Calculation Unit) must be set to zero on the field device.)
  • "FMS Configuration Support" (This is built dynamically and is not associated with a data group.)
  • "Liquid Preference Parameters" (LiqPref) (For liquid meter only.)
  • "Meter Config Params" (MetCfg) (For 100 and 500 field devices v8.1.1 and greater. Must be instantiated.)
  • "Meter Config Params (Basic)" (MetCfg) (For 107 field devices v8.1.1 and greater. Must be instantiated.)
  • "Meter Config Params (Extra 107)" (FloBoss 107 only.)
  • "ROC Config" (300-Series only.)
  • "ROCPAC Support for FMS" (ROC300-Series ROCPAC only.)
  • "Run Parameters" (Except for ROC300-Series ROCPAC.)
  • "System Variables"
  • "V-Cone 5 Meter Run Configuration"/"V-Cone 6 Meter Run Configuration" (for 107 field devices. Must be instantiated.)

FmsEvent

"FMS Events"

Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time.

FMS data group units displayed in the DDS reflect their points of origin.

A "Special Configuration Events" event appears in the Event Category column of the "FMS Events" data if any one of the following configuration properties is changed on a field device:

  • Primary Calculation Type
  • Primary Calculation Version
  • Heating Value (Volume or Mass)
  • Heating Basic/Units (Mass to Volume, or Volume to Mass)

The "special" status sets a flag for the event's display in FMS Explorer. See Special Configuration Events for more information about these events.

Dependencies:
  • "Audit Log" (For Industry Canada versions of 300-/400-Series only if the useAudit attribute is set to "true" in the "FMS Event" data group in the template) or Events Log
  • "FMS Configuration Data"

FmsHistDGm

"FMS Daily PM History"

History points must be defined in this data group's properties.

Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time.

FMS data group units displayed in the DDS reflect their points of origin.

For information about how ordinals are formed for this data group, see History Ordinals and Points.

Dependencies:
  • "History Indices"

FmsHistDGq

"FMS Daily PQ History"

History points must be defined in this data group's properties.

Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time.

FMS data group units displayed in the DDS reflect their points of origin.

For information about how ordinals are formed for this data group, see History Ordinals and Points.

Dependencies:
  • "History Indices"

FmsHistHGm

"FMS Hourly PM History"

History points must be defined in this data group's properties.

You can use the "History Point List" data group to locate history point values.

Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time.

FMS data group units displayed in the DDS reflect their points of origin.

For information about how ordinals are formed for this data group, see History Ordinals and Points.

Dependencies:
  • "History Indices" (This is built dynamically and is not associated with a data group.)
  • "Periodic History" (One for each process variable mapped to a history point.)

FmsHistHGq

"FMS Hourly PQ History"

History points must be defined in this data group's properties.

You can use the "History Point List" data group to locate history point values.

Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time.

FMS data group units displayed in the DDS reflect their points of origin.

For information about how ordinals are formed for this data group, see History Ordinals and Points.

Dependencies:
  • "History Indices" (This is built dynamically and is not associated with a data group.)
  • "Periodic History" (One for each process variable mapped to a history point.)

FmsProduct

"FMS Liquid Product" enables the retrieval of liquid product data by an associated CygNet Measurement system.

A single set of two liquid products is shared by all liquid meters. However, liquid product data is sent to FMS with meter-specific data on a per-meter basis. Each instance of LiqMeter and its corresponding FmsProduct data group share both the set of liquid products as well as meter-specific product values.

Applicable RtuConfig, FmsConfig, LiqMeter, and FmsProduct data group types must be instantiated to poll FmsProduct. RtuConfig and FmsConfig must be polled before polling FmsProduct.

Dependencies:
  • "FMS Configuration" (FmsConfig)
  • "Liquid Meter Run Configuration" (LiqMeter)

FmsRocPac

"ROCPAC Support for Fms"

FST Parameters

The "FST Parameters" data group uses point type 16.

FSTReg

"FST Registers "

GenTLP

"Generic TLP Data"

See Generic TLP Data Group.

GmrRocPac

"ROCPAC for FMS Legacy"

Hist60

The "Sixty Minute Point History" data group is used to optimize the retrieval of row-based minute history for multiple points using opcode 126.

See also History Retrieval Optimization.

HistMultiD

The "History Multiple Points Daily" data group is used to optimize the retrieval of row-based daily history for multiple points using opcode 136.

See also History Retrieval Optimization.

HistMultiE

The "History Multiple Points Extended" data group is used to optimize the retrieval of row-based extended history for multiple points using opcode 136.

See also History Retrieval Optimization.

HistMultiP

The "History Multiple Points Periodic" data group is used to optimize the retrieval of row-based periodic history for multiple points using opcode 136.

See also History Retrieval Optimization.

HistPtCfg

"History Point List"

IoPntCfg

"I/O Point List" enables you to request the type and/or logical number of all I/O points in their physical order from a connected field device. This in turn enables you to focus on only those I/O point collections you most care about, making it easier to create your own I/O data groups. IoPntCfg uses opcode 50.

You can select the Add Data Groups button to automatically create I/O data groups that have not previously been created. The Tag column does not display a value until that I/O data group has been retrieved.

LiqMeter

The "Liquid Meter Parameters" data group uses point type 25.

See also Collecting Liquid Periodic Data.

LiqPref

The "Liquid Preferences Parameters" data group uses point type 22.

See also Collecting Liquid Periodic Data.

LiqProd

The "Liquid Product Parameters" data group uses point type 23.

See also Collecting Liquid Periodic Data.

Login

The "Login Request" data group is only relevant if the port being used to communicate with the target field device is security enabled.

This data group enables a user with valid credentials to communicate with a field device from the CygNet host. As long as that user is logged in, subsequent messaging is allowed through the relevant communication port and the user's ID is included in event log records.

If the relevant port is security enabled, a log-in request using invalid data will fail with an error message of "device rejected request, code 21". Subsequent invalid requests will fail with "device rejected request, code 20", which is a security failure. The "Login Credentials" data group can be used to see the valid credentials as they are defined on a field device. If the relevant port is security disabled, a log-in request with invalid data will succeed since no internal Emerson validation is performed.

A user might be unexpectedly logged out if any one of the following conditions occurs:

  • A log-in request (using opcode 17) is made by a different valid user
  • The field device experiences a cold start
  • The field device firmware is upgraded
  • Any of several timeout conditions occurs, including a communication session timeout

See Emerson device security documentation for more details.

LoginCr

The "Login Credentials" data group uses point type 57.

This data group reads operator IDs and their corresponding password and access level from a field device. These items must be configured on the field device before CygNet can read them. The field device does not allow the credentials to be configured from external applications like CygNet.

The credentials that are displayed in this data group are the only valid ones that can be used in the "Login Request" data group.

As with all CygNet data groups, you can set individual CygNet security permissions for this data group.

MetCfg

"Meter Config Parameters"

MetCfg

"Meter Config Params (Basic)"

MetCfg107

"Meter Config Params (Extra 107)"

MetFlow

"Meter Flow Values"

MetFlow

"Meter Flow Values (Basic)"

MetFlowE

"Meter Flow Values (Extra 107)"

MVS

"Multi-Variable Sensor"

PerHst

"Periodic History"

See History Retrieval Optimization.

For information about how ordinals are formed for this data group, see History Ordinals and Points.

PIDControl

"PID"

PIDParms

"PID Control Params"

PIDParmsE

"PID Control Params (Extended)"

PulseInput

"Pulse Input"

RtuConfig

A valid "ROC Config" data group must be retrieved before other data groups can be retrieved or sent. The data group should always be repolled if there are configuration changes to the field device, after a CygNet upgrade, after importing a device or after modifying the device template file.

RunParm

"Run Parameters"

SingleTlp

"Single TLP" enables you to read from and write to a single user-specified TLP. You can use a single-element data group on an ad hoc basis from a data group editor or set up a UIS command that uses a single-element data group.

You can use a remote device editor dialog box to enter a user-defined TLP. To do so, configure the data group as usual, but type in the desired values for the fields Point type, Logical #, and Parameter # in the TLP settings. Both the Point type and Parameter # fields are combo boxes that enable you to type your own values rather than only selecting from a list of known TLPs.

SoftPntExt

"Soft Points Extended" applies to 107 and 107IC remote devices. Uses point type 98 to retrieve an extended definition of soft points.

SoftPoints

"Soft Points"

A type of point with generic parameters that you can configure to hold data as desired.

SysFlgs

"System Flags"

SysVars

"System Variables"

Tank

"Tank Parameters"

UserPgStat

The "User Program Status" data group uses point type 94.

It enables the retrieval of status information for a user-defined C program used on a specific Emerson field device.

If the user program version information has not been successfully retrieved from the field device, any TLP using the minUProgVer attribute will be excluded. To retrieve the user program version information, poll the "ROC Config" (RtuConfig) data group or the "User Program Status" (UserPgStat) data group.

See also User Programs.

UserProg

The "User Program Configuration" data group uses point type 94.

It enables the retrieval of configuration information for a user-defined C program used on a specific Emerson field device.

See also User Programs.

VCone5

"V-Cone 5 Meter Run Configuration"

The corresponding V-Cone user program is called V-Cone_5.bin. It is loaded into user program location 5 and uses point type 31.

This data group is only meaningful if you've installed the relevant cone user program on your field device. If you are uncertain, poll "User Program Status" and confirm.

VCone6

"V-Cone 6 Meter Run Configuration"

The corresponding V-Cone user program is called V-Cone_6.bin. It is loaded into user program location 6 and uses point type 33.

This data group is only meaningful if you've installed the relevant cone user program on your field device. If you are uncertain, poll "User Program Status" and confirm.

XRunParm

The "Extra Run Parameters" data group uses point type 42.

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.